OstreeMutableTree: Document ostree_mutable_tree_ensure_dir
authorWilliam Manley <will@williammanley.net>
Fri, 22 Jun 2018 11:00:29 +0000 (12:00 +0100)
committerAtomic Bot <atomic-devel@projectatomic.io>
Mon, 25 Jun 2018 16:22:21 +0000 (16:22 +0000)
Closes: #1645
Approved by: jlebon

src/libostree/ostree-mutable-tree.c

index f46e36dbe42288c0671350dffdb9b786dce90e9d..e5e282d4d02232dee76da84d73b4cce992ca74d7 100644 (file)
@@ -186,6 +186,16 @@ ostree_mutable_tree_replace_file (OstreeMutableTree *self,
   return ret;
 }
 
+/**
+ * ostree_mutable_tree_ensure_dir:
+ * @self: Tree
+ * @name: Name of subdirectory of self to retrieve/creates
+ * @out_subdir: (out) (transfer full): the subdirectory
+ * @error: a #GError
+ *
+ * Returns the subdirectory of self with filename @name, creating an empty one
+ * it if it doesn't exist.
+ */
 gboolean
 ostree_mutable_tree_ensure_dir (OstreeMutableTree *self,
                                 const char        *name,